Skip to main content
Feedback

Event Trigger API

Event Triggers are a way for a customer to integrate their own systems with the Cloud API Management service. They enable a customer to receive data when particular events happen in the Cloud API Management service, such as a developer registering, an application being created, or the limits being changed on a developer's key.

The Event Trigger API consists of HTTP-based calls that the Cloud API Management service will make to a designated, customer-hosted endpoint, for example, http://mycustomerdomain.com/masherycallbacks. These calls are made after executing administration operations, such as create, update, and delete, for the API Management objects - Member, Application, Key, and Package Key. In other words, event trigger API calls are made after the data is saved in the Cloud API Management database.

note

The customer-hosted endpoint must support additional path elements and query parameters, both of which are documented on each object's detail documentation page. The entry for the customer-hosted endpoint, as entered into the Cloud API Management API Admin Console, is simply the root of the API that will be called.

Example

An example of what a call would be produced when generating an event trigger for updating a Cloud API Management member object is provided in Supported Event Triggers. http://mycustomerdomain.com/masherycallbacks/v1/member/123456

important

Event Triggers are set up and managed by Cloud API Management Support. For assistance, contact Boomi Account Representative.

Supported Event Triggers

The following table summarizes the event triggers supported by API Management.

ObjectEventHTTP Request Type of Call made to Customer-hosted EndpointData Sent to Customer-hosted EndpointData Returned from Customer-hosted Endpoint
MemberCreatePUTMember JSON or application/x-www-form-urlencoded dataMember JSON
UpdatePUT
DeleteDELETE
ApplicationCreatePUTApplication JSON or application/x-www-form-urlencoded dataApplication JSON
UpdatePUT
DeleteDELETE
KeyCreatePUTKey JSON or application/x-www-form-urlencoded dataKey JSON
UpdatePUT
DeleteDELETE
Package KeyCreatePUTPackage Key JSON or application/x-www-form-urlencoded dataPackage Key JSON
UpdatePUT
DeleteDELETE
On this Page